codepointOffset

Type

function

Summary

Returns the number of codepoints between the beginning of a value and an occurrence of a specified string.

Syntax

codepointOffset(<stringToFind>, <stringToSearch> [, <codepointsToSkip>])

Description

Use the codepointOffset function to find which codepoint a string occurs in.

The value returned by the codepointOffset function is the number of the codepoint where the stringToFind appears in stringToSearch. If the stringToFind is not in stringToSearch, the codepointOffset function returns zero. If the stringToFind is more than one codepoint, the codepointOffset function always returns zero, even if the stringToFind appears in the stringToSearch.

If you specify how many codepointsToSkip, the codepointOffset function skips the specified number of sentences in the stringToSearch. The value returned is relative to this starting point instead of the beginning of the stringToSearch.

Parameters

Name	Type	Description
stringToFind	string
stringToSearch	string
codepointsToSkip		The codepointsToSkip is a non-negative integer. If you don't specify how many codepointsToSkip, the codepointOffset function does not skip any codepoints.

Examples

codepointOffset(tCodePoint,"This is the string to search")

Related

function: wordOffset, paragraphOffset, tokenOffset, sentenceOffset, byteOffset, truewordOffset, codeunitOffset, offset

keyword: codepoint

property: wholeMatches

Compatibility and Support

Introduced

LiveCode 7.0

OS

mac

windows

linux

ios

android

Platforms

desktop

server

mobile